Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[OUDS] Docs: empty pages content #2612

Merged
merged 1 commit into from
Jul 12, 2024
Merged

Conversation

julien-deramond
Copy link
Contributor

@julien-deramond julien-deramond commented Jul 10, 2024

Description

This PR finalizes the clean-up of our OUDS Web main branch before starting the development:

  • For pages that are mentioned in the side menu:
    • Remove the content of the Markdown files
    • Use the strike-through approach in the side menu to inform users that the content is not available
    • For each of these pages, a callout is displayed in the page to inform that the content is not yet available
    • Note: some easy pages in the About section are kept as they already work
  • For the homepage, I kept only the content that is usable as is
  • The version dropdown has been simplified
  • The "Design Guidelines" and "Solaris Icons" links have been removed
  • The footer has been adapted with the available content
  • The examples page is empty and all the examples have been removed
    • I've created a fake example (not mentioned in the examples page) just in order to keep the compilation/packaging system

Please be aware that when some resources were not used anymore, they were dropped from the repository as well.

OUDS Web and Bootstrap versions

Boosted and Bootstrap were using the exact same versions at the same time. Now we have to deal with different versions, and so, some Hugo params must be split:

  • New bootstrap_docs_version parameter set to 5.3
  • New bootstrap_current_version parameter set to 5.3.3

System of URLs

This PR fixes the URLs issues and configuration and works when:

  • npm run start
  • https://deploy-preview-2612--boosted.netlify.app/
  • npm run docs, then run php -S localhost:8008 in _site directory
  • npm run release, mv _site/ouds-web /tmp, git checkout gh-pages, rm -rf ouds-web/*, mv /tmp/ouds-web/* ouds-web/, then run php -S localhost:8008

Instead of adding a /ouds-web everywhere in the code like tried in https://github.com/Orange-OpenSource/Orange-Boosted-Bootstrap/pull/2614/files, a modify-site.sh script does it only when we build the documentation targetting gh-pages.
It allows running the documentation locally and via Netlify as usual, and we'll only need to drop the usage of this script whenever OUDS Web will replace Boosted.

Please note that there are some edge cases that don't work for now until the new DNS is correctly set up, but should be automatically handled in a near future:


After the merge

  •  Take into account [OUDS] Docs: empty pages content #2612 (comment)
  • Make modify-docs.sh script work on Windows too
  • Generate patch versions (0.0.1, 0.0.2, etc.) with the real process to check that all download references and links work as expected (zip files, examples packages, npm packages, etc.)
  • Fix ReferenceError: boosted is not defined, and handle the JS part correctly
  • We'll need to track everything that has been temporarily removed in [OUDS] [Tracking] Documentation content #2611 so that it can be reintroduced step by step for OUDS Web

Storybook

The following URLs should work:

@julien-deramond julien-deramond added the docs Improvements or additions to documentation label Jul 10, 2024
@julien-deramond julien-deramond added this to the OUDS milestone Jul 10, 2024
Copy link

netlify bot commented Jul 10, 2024

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 24f5b89
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/6691115f82d26d0008197ade
😎 Deploy Preview https://deploy-preview-2612--boosted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@julien-deramond julien-deramond force-pushed the ouds/main-jd-empty-pages branch from 0ba4b69 to 2a92315 Compare July 10, 2024 12:32
@julien-deramond julien-deramond force-pushed the ouds/main-jd-empty-pages branch from a32dd1a to 24f5b89 Compare July 12, 2024 11:19
@julien-deramond julien-deramond marked this pull request as ready for review July 12, 2024 11:29
Copy link
Member

@louismaximepiton louismaximepiton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👌

.bundlewatch.config.json Show resolved Hide resolved
@julien-deramond julien-deramond merged commit e1b08bb into ouds/main Jul 12, 2024
28 checks passed
@julien-deramond julien-deramond deleted the ouds/main-jd-empty-pages branch July 12, 2024 13:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
Development

Successfully merging this pull request may close these issues.

4 participants